<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2014 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: JSimpleClass.html 842 2015-03-07 18:20:42Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.jsimpledb.annotation;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.lang.annotation.Documented;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import java.lang.annotation.ElementType;<a name="line.11"></a>
<span class="sourceLineNo">012</span>import java.lang.annotation.Retention;<a name="line.12"></a>
<span class="sourceLineNo">013</span>import java.lang.annotation.RetentionPolicy;<a name="line.13"></a>
<span class="sourceLineNo">014</span>import java.lang.annotation.Target;<a name="line.14"></a>
<span class="sourceLineNo">015</span><a name="line.15"></a>
<span class="sourceLineNo">016</span>/**<a name="line.16"></a>
<span class="sourceLineNo">017</span> * Java annotation for Java classes that are {@link org.jsimpledb.JSimpleDB} object model types.<a name="line.17"></a>
<span class="sourceLineNo">018</span> *<a name="line.18"></a>
<span class="sourceLineNo">019</span> * &lt;p&gt;<a name="line.19"></a>
<span class="sourceLineNo">020</span> * Typically such classes are declared {@code abstract} and contain {@code abstract} Java bean getter methods<a name="line.20"></a>
<span class="sourceLineNo">021</span> * with {@link JField &amp;#64;JField}, {@link JSetField &amp;#64;JSetField}, etc. annotations that<a name="line.21"></a>
<span class="sourceLineNo">022</span> * define the fields of the object type.<a name="line.22"></a>
<span class="sourceLineNo">023</span> * &lt;/p&gt;<a name="line.23"></a>
<span class="sourceLineNo">024</span> *<a name="line.24"></a>
<span class="sourceLineNo">025</span> * &lt;p&gt;<a name="line.25"></a>
<span class="sourceLineNo">026</span> * The following annotations are supported on the methods of a {@link JSimpleClass &amp;#64;JSimpleClass}-annotated class:<a name="line.26"></a>
<span class="sourceLineNo">027</span> * &lt;ul&gt;<a name="line.27"></a>
<span class="sourceLineNo">028</span> *  &lt;li&gt;{@link JField &amp;#64;JField} - defines a simple value or reference field<a name="line.28"></a>
<span class="sourceLineNo">029</span> *  &lt;li&gt;{@link JSetField &amp;#64;JSetField} - defines a {@link java.util.NavigableSet} field<a name="line.29"></a>
<span class="sourceLineNo">030</span> *  &lt;li&gt;{@link JListField &amp;#64;JListField} - defines a {@link java.util.List} field<a name="line.30"></a>
<span class="sourceLineNo">031</span> *  &lt;li&gt;{@link JMapField &amp;#64;JMapField} - defines a {@link java.util.NavigableMap} field<a name="line.31"></a>
<span class="sourceLineNo">032</span> *  &lt;li&gt;{@link OnChange &amp;#64;OnChange} - annotates a method to be invoked when some field (possibly seen through<a name="line.32"></a>
<span class="sourceLineNo">033</span> *      a path of references) changes<a name="line.33"></a>
<span class="sourceLineNo">034</span> *  &lt;li&gt;{@link OnCreate &amp;#64;OnCreate} - annotates a method to be invoked just after object creation<a name="line.34"></a>
<span class="sourceLineNo">035</span> *  &lt;li&gt;{@link OnDelete &amp;#64;OnDelete} - annotates a method to be invoked just prior to object deletion<a name="line.35"></a>
<span class="sourceLineNo">036</span> *  &lt;li&gt;{@link OnVersionChange &amp;#64;OnVersionChange} - annotates a method to be invoked when the object's schema version changes<a name="line.36"></a>
<span class="sourceLineNo">037</span> *  &lt;li&gt;{@link Validate &amp;#64;Validate} - annotates a method to be invoked whenever the object is (re)validated<a name="line.37"></a>
<span class="sourceLineNo">038</span> * &lt;/ul&gt;<a name="line.38"></a>
<span class="sourceLineNo">039</span> *<a name="line.39"></a>
<span class="sourceLineNo">040</span> * &lt;p&gt;<a name="line.40"></a>
<span class="sourceLineNo">041</span> * The above annotations may be present on any overridden supertype method, including methods in superclasses and superinterfaces<a name="line.41"></a>
<span class="sourceLineNo">042</span> * (whether or not annotated with {@link JSimpleClass &amp;#64;JSimpleClass}).<a name="line.42"></a>
<span class="sourceLineNo">043</span> * &lt;/p&gt;<a name="line.43"></a>
<span class="sourceLineNo">044</span> *<a name="line.44"></a>
<span class="sourceLineNo">045</span> * &lt;p&gt;<a name="line.45"></a>
<span class="sourceLineNo">046</span> * The subclass of the annotated class that is generated by {@link org.jsimpledb.JSimpleDB} will implement<a name="line.46"></a>
<span class="sourceLineNo">047</span> * {@link org.jsimpledb.JObject}, so the (abstract) annotated class may be declared that way.<a name="line.47"></a>
<span class="sourceLineNo">048</span> * The annotated class must have a zero-parameter constructor.<a name="line.48"></a>
<span class="sourceLineNo">049</span> * &lt;/p&gt;<a name="line.49"></a>
<span class="sourceLineNo">050</span> */<a name="line.50"></a>
<span class="sourceLineNo">051</span>@Retention(RetentionPolicy.RUNTIME)<a name="line.51"></a>
<span class="sourceLineNo">052</span>@Target(ElementType.TYPE)<a name="line.52"></a>
<span class="sourceLineNo">053</span>@Documented<a name="line.53"></a>
<span class="sourceLineNo">054</span>public @interface JSimpleClass {<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span>    /**<a name="line.56"></a>
<span class="sourceLineNo">057</span>     * The name of this object type.<a name="line.57"></a>
<span class="sourceLineNo">058</span>     *<a name="line.58"></a>
<span class="sourceLineNo">059</span>     * &lt;p&gt;<a name="line.59"></a>
<span class="sourceLineNo">060</span>     * If equal to the empty string (default value),<a name="line.60"></a>
<span class="sourceLineNo">061</span>     * the {@linkplain Class#getSimpleName simple name} of the annotated Java class is used.<a name="line.61"></a>
<span class="sourceLineNo">062</span>     * &lt;/p&gt;<a name="line.62"></a>
<span class="sourceLineNo">063</span>     *<a name="line.63"></a>
<span class="sourceLineNo">064</span>     * @return object type name<a name="line.64"></a>
<span class="sourceLineNo">065</span>     */<a name="line.65"></a>
<span class="sourceLineNo">066</span>    String name() default "";<a name="line.66"></a>
<span class="sourceLineNo">067</span><a name="line.67"></a>
<span class="sourceLineNo">068</span>    /**<a name="line.68"></a>
<span class="sourceLineNo">069</span>     * Storage ID for this object type. Value should be positive;<a name="line.69"></a>
<span class="sourceLineNo">070</span>     * if zero, the configured {@link org.jsimpledb.StorageIdGenerator} will be consulted to auto-generate a value.<a name="line.70"></a>
<span class="sourceLineNo">071</span>     *<a name="line.71"></a>
<span class="sourceLineNo">072</span>     * @return object type storage ID<a name="line.72"></a>
<span class="sourceLineNo">073</span>     * @see org.jsimpledb.StorageIdGenerator#generateClassStorageId StorageIdGenerator.generateClassStorageId()<a name="line.73"></a>
<span class="sourceLineNo">074</span>     */<a name="line.74"></a>
<span class="sourceLineNo">075</span>    int storageId() default 0;<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span>    /**<a name="line.77"></a>
<span class="sourceLineNo">078</span>     * Composite indexes (i.e., indexes on two or more fields) defined on this type.<a name="line.78"></a>
<span class="sourceLineNo">079</span>     *<a name="line.79"></a>
<span class="sourceLineNo">080</span>     * @return object type composite indexes<a name="line.80"></a>
<span class="sourceLineNo">081</span>     */<a name="line.81"></a>
<span class="sourceLineNo">082</span>    JCompositeIndex[] compositeIndexes() default {};<a name="line.82"></a>
<span class="sourceLineNo">083</span><a name="line.83"></a>
<span class="sourceLineNo">084</span>    /**<a name="line.84"></a>
<span class="sourceLineNo">085</span>     * Whether to automatically generate database fields from un-annotated abstract Java bean methods.<a name="line.85"></a>
<span class="sourceLineNo">086</span>     *<a name="line.86"></a>
<span class="sourceLineNo">087</span>     * &lt;p&gt;<a name="line.87"></a>
<span class="sourceLineNo">088</span>     * If true, database fields corresponding to all &lt;b&gt;abstract&lt;/b&gt; bean property getter methods will<a name="line.88"></a>
<span class="sourceLineNo">089</span>     * be auto-generated even if there is no {@link JField &amp;#64;JField}, {@link JSetField &amp;#64;JSetField},<a name="line.89"></a>
<span class="sourceLineNo">090</span>     * {@link JListField &amp;#64;JListField}, or {@link JMapField &amp;#64;JMapField} annotation. Note &lt;i&gt;this includes<a name="line.90"></a>
<span class="sourceLineNo">091</span>     * superclass and interface methods&lt;/i&gt;.<a name="line.91"></a>
<span class="sourceLineNo">092</span>     * &lt;/p&gt;<a name="line.92"></a>
<span class="sourceLineNo">093</span>     *<a name="line.93"></a>
<span class="sourceLineNo">094</span>     * &lt;p&gt;<a name="line.94"></a>
<span class="sourceLineNo">095</span>     * Getter methods with return type assignable to {@link java.util.Set}, {@link java.util.List}, and {@link java.util.Map}<a name="line.95"></a>
<span class="sourceLineNo">096</span>     * will cause the corresponding collection fields to be created; other getter/setter method pairs will cause<a name="line.96"></a>
<span class="sourceLineNo">097</span>     * the corresponding simple fields to be generated. Auto-generation of storage ID's is performed by the<a name="line.97"></a>
<span class="sourceLineNo">098</span>     * configured {@link org.jsimpledb.StorageIdGenerator}.<a name="line.98"></a>
<span class="sourceLineNo">099</span>     * &lt;/p&gt;<a name="line.99"></a>
<span class="sourceLineNo">100</span>     *<a name="line.100"></a>
<span class="sourceLineNo">101</span>     * @return whether to auto-generate fields from abstract methods<a name="line.101"></a>
<span class="sourceLineNo">102</span>     * @see org.jsimpledb.JSimpleDBFactory#setStorageIdGenerator JSimpleDBFactory.setStorageIdGenerator()<a name="line.102"></a>
<span class="sourceLineNo">103</span>     */<a name="line.103"></a>
<span class="sourceLineNo">104</span>    boolean autogenFields() default true;<a name="line.104"></a>
<span class="sourceLineNo">105</span>}<a name="line.105"></a>
<span class="sourceLineNo">106</span><a name="line.106"></a>




























































</pre>
</div>
</body>
</html>
